Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update span name recommendation for HTTP Server #287

Merged
merged 5 commits into from
Sep 25, 2023

Conversation

gouthamve
Copy link
Member

This is to bring it inline with: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server-semantic-conventions

Merge requirement checklist

@gouthamve gouthamve requested review from a team August 28, 2023 15:06
@gouthamve
Copy link
Member Author

I am not sure if this is correct, and might conflict with #270

Should I just remove this line from here?

docs/http/http-spans.md Outdated Show resolved Hide resolved
@pyohannes
Copy link
Contributor

@gouthamve Please rebase to make the checks pass.

@pellared

This comment was marked as outdated.

@AlexanderWert
Copy link
Member

@gouthamve

I don't fully get the change here, I guess I'm missing some context here.
Why would we stop recommending to use the route in HTTP server span names?

@pyohannes
Copy link
Contributor

@AlexanderWert

I don't fully get the change here, I guess I'm missing some context here.
Why would we stop recommending to use the route in HTTP server span names?

It's not about not using the route anymore. How to set the span name is clearly defined in a dedicated section of this document:

HTTP server span names SHOULD be {method} {http.route} if there is a (low-cardinality) http.route available (see below for the exact definition of the [{method}](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http spans.md#method-placeholder) placeholder).

If there is no (low-cardinality) http.route available, HTTP server span names SHOULD be {method}.

The paragraph to remove in this PR suggested that the span name should be set just to {http.route}, without a trailing {method}. That's incorrect.

@AlexanderWert
Copy link
Member

@AlexanderWert

I don't fully get the change here, I guess I'm missing some context here.
Why would we stop recommending to use the route in HTTP server span names?

It's not about not using the route anymore. How to set the span name is clearly defined in a dedicated section of this document:

HTTP server span names SHOULD be {method} {http.route} if there is a (low-cardinality) http.route available (see below for the exact definition of the [{method}](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http spans.md#method-placeholder) placeholder).
If there is no (low-cardinality) http.route available, HTTP server span names SHOULD be {method}.

The paragraph to remove in this PR suggested that the span name should be set just to {http.route}, without a trailing {method}. That's incorrect.

@pyohannes Thanks! Now I get it!

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx @gouthamve!

and thx @pyohannes for the explainer!

@trask
Copy link
Member

trask commented Sep 22, 2023

@open-telemetry/specs-semconv-maintainers I think this is good to merge

@jsuereth jsuereth merged commit 1d3d63b into open-telemetry:main Sep 25, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants